/*
 * MIT License
 *
 * Copyright (c) 2020 wen.gu <454727014@qq.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/***************************************************************************
 * Name: xerror.h
 *
 * Purpose: error define
 *
 * Developer:
 *   wen.gu , 2023-07-07
 *
 * TODO:
 *
 ***************************************************************************/

#ifndef __SHMIPC_CORE_XERROR_H__
#define __SHMIPC_CORE_XERROR_H__

#include <cstdint>


namespace shmipc::core {

/** error code define */
enum class XErrC: uint8_t {
    OK = 0,
    InvalidStatus,
    InvalidArgument,
    PipeFull, /** need retry */    
    SocketOpenFailed,
    BindFailed,
    ConnectFailed,
    Undefined,
    OutOfRange,
    TimeOut,
    Disconnected,
    ListenFailed,
    InvalidClientId,
    NotFound,
    NotImplementation,
    InsufficientReousces,
    InvalidMessage,
    InvalidMessageStart,
    ProtocolVersionMismatch,
    PackageIndexMismatch,
    InvalidLength,
    TryAgain,
    WouldBlock,
    Interrupted,
    AlreadyExist,
    Unsupported,
};

//todo define and implementation the map of error code and error information(string) 

const char* XErr2Str(XErrC errc);

} //namespace shmipc::core


#endif /** !__SHMIPC_CORE_XERROR_H__ */